Skip to content

Fix Haddock documentation for fromAscListWithKey functions #1161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
meooow25 merged 2 commits into from
Dec 27, 2025
Merged

Fix Haddock documentation for fromAscListWithKey functions #1161

meooow25 merged 2 commits into from
Dec 27, 2025
+8 −5

Conversation

@RikuMinamiyama
Copy link
Contributor

@RikuMinamiyama RikuMinamiyama commented Oct 3, 2025

Overview
This PR fixes Haddock documentation issues in the fromAscListWithKey function documentation.

Correction details

  • Fix missing backticks in 'fromAscListWithKey' reference in fromListWithKey documentation
  • Improve English phrasing: "on equal keys" → "for equal keys"
  • Clarify that the combining function receives the key: "with a combining function that receives the key for equal keys"
  • Enhance examples with more comprehensive test cases including empty list
  • Apply consistent changes to both Strict and Lazy versions

Modified files

  • containers/src/Data/IntMap/Internal.hs
  • containers/src/Data/IntMap/Strict/Internal.hs

Test

  • Documentation builds without errors
  • Changes are consistent between Strict and Lazy versions
  • Examples are syntactically correct

This is my first OSS contribution and I'm not a native English speaker. Please let me know if there are any issues with the documentation changes.

Fixes #1154

meooow25
meooow25 requested changes Dec 26, 2025
View reviewed changes
Copy link
Contributor

@meooow25 meooow25 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, apologies for missing this PR. Your changes to the examples seem good, and the backtick fix for 'fromAscListWithKey' is also an improvement.

However, I would prefer if you drop the other language changes. Those seem clear to me and don't need adjustment.

@RikuMinamiyama
Copy link
Contributor Author

RikuMinamiyama commented Dec 27, 2025 •
edited
Loading

@meooow25

Thank you for the review! I've addressed your feedback and reverted the language changes as requested.

The PR now only includes:

  • The improved examples for fromAscListWithKey
  • The backtick fix for the 'fromAscListWithKey' reference

All other language changes have been removed. Please let me know if you'd like any further adjustments.

meooow25
meooow25 approved these changes Dec 27, 2025
View reviewed changes
Copy link
Contributor

@meooow25 meooow25 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@meooow25 meooow25 merged commit 7cd38d1 into haskell:master Dec 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@meooow25 meooow25 meooow25 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Incorrect example for IntMap.Strict.fromAscListWithKey

2 participants

@RikuMinamiyama @meooow25